/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.netbeans.api.editor.document;

/**
 * Allows to inspect document's lock state.
 * <i>originally part of <code>BaseDocument</code> interface.
 * @author sdedic
 */
public interface DocumentLockState {
    /**
     * Determines if the document is write-locked by some thread.
     * @return true, if the document is write-locked.
     */
    public boolean isWriteLocked();
    
    /**
     * Determines, if the document is read-locked.
     * Note that true means that some thread acquired a read-lock, not that the
     * current thread read-locked the document.
     * s
     * @return true, if the document is read-locked.
     */
    public boolean isReadLocked();
}
